Extract NLP-based Query Results

Runs an Natural Language query against the specified data source and extracts the query result data into the specified format (CSV, JSON, XML).

Method

/API3/analytics/extractNlpQueryResult

  • API Section: /API3/analytics
  • API Version: 3.0
  • From Release: 2023.10
  • Usage: REST API and Client SDK libraries. REST APIs via POST actions only.
  • Usage by:
    • Enterprise Admin
    • Domain Admin
    • Pro
    • Analyst
    • Viewer
    • Basic

Method Signature

Input Parameters

Name

data

Object Type

NlpQueryExportData

Description

The query export object used to specify how to extract nlp query results.

Output Response

Successful Result Code

200

Response Type

string

Description of Response Type

successful operation

Notes

Queries are extracted in flattened tabular format – and do not represent the cartesian placement of the data.

Code Snippets

Use the Authentication API methods to generate an access 'key' or 'token' for use in code as shown below.

TypeScript
Curl
Java
C#
Python
PHP
curl -X POST \
-H "paToken: [[apiKey]]" \
 -H "Accept: application/json,application/json;charset=utf-8,text/csv,text/csv;charset=utf-8,application/xml,application/xml;charset=utf-8,text/plain,text/plain;charset=utf-8" \
 -H "Content-Type: application/json" \
 "http://Your.Server.URL/API3/analytics/extractNlpQueryResult" \
 -d '{
  "exportOptions" : {
    "columnHeaderAsCaption" : true,
    "removeValueBasedFilters" : true,
    "showUniqueName" : true
  },
  "model" : "model",
  "nlpSentence" : "nlpSentence",
  "databaseId" : "databaseId",
  "serverId" : "serverId"
}'

import com.pyramidanalytics.*;
import com.pyramidanalytics.auth.*;
import com.pyramidanalytics.model.*;
import com.pyramidanalytics.api.AnalyticsServiceApi;

import java.util.*;
import java.time.*;

public class AnalyticsServiceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://Your.Server.URL/");
        
        // Configure API key authorization: paToken
        ApiKeyAuth paToken = (ApiKeyAuth) defaultClient.getAuthentication("paToken");
        paToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //paToken.setApiKeyPrefix("Token");

        // Create an instance of the API class
        AnalyticsServiceApi apiInstance = new AnalyticsServiceApi();
        // Initialize the data parameter object for the call
        NlpQueryExportData data = ; // Create the input object for the operation, type: NlpQueryExportData 

        try {
            String result = apiInstance.extractNlpQueryResult(data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsServiceApi#extractNlpQueryResult");
            e.printStackTrace();
        }
    }
}

import * as PyramidAnalyticsWebApi from "com.pyramidanalytics";

// Create an instance of the API class
const api = new PyramidAnalyticsWebApi.AnalyticsServiceApi("http://Your.Server.URL")

// Configure API key authorization: paToken
api.setApiToken("YOUR API KEY");

const data = ; // {NlpQueryExportData} 

api.extractNlpQueryResult(data).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});


using System;
using System.Diagnostics;
using PyramidAnalytics.Sdk.Api;
using PyramidAnalytics.Sdk.Client;
using PyramidAnalytics.Sdk.Model;

public class extractNlpQueryResultExample
{
    public static void Main()
    {
        Configuration conf = new Configuration();
        conf.BasePath = "http://Your.Server.URL/";
        
        
        // Configure API key authorization: paToken
        conf.ApiKey.Add("paToken", "YOUR_API_KEY");
        // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
        // conf.ApiKeyPrefix.Add("paToken", "Bearer");

        GlobalConfiguration.Instance = conf;
        
        // Create an instance of the API class
        var apiInstance = new AnalyticsServiceApi();
        // Initialize the data parameter object for the call
        var data = new NlpQueryExportData(); // NlpQueryExportData | 

        try {
            // Runs an Natural Language query against the specified data source and extracts the query result data into the specified format (CSV, JSON, XML).
            string result = apiInstance.extractNlpQueryResult(data);
            Debug.WriteLine(result);
        } catch (Exception e) {
            Debug.Print("Exception when calling AnalyticsServiceApi.extractNlpQueryResult: " + e.Message );
        }
    }
}


import com.pyramidanalytics
from com.pyramidanalytics import ApiException
from com.pyramidanalytics import AnalyticsServiceApi
from pprint import pprint

        
# Configure API key authorization: paToken
api_config = com.pyramidanalytics.Configuration(host = 'http://Your.Server.URL/', api_key={ paToken:'YOUR_ACCESS_TOKEN' })

with com.pyramidanalytics.ApiClient(api_config) as api_client:
    # Create an instance of the API class
    api_instance = AnalyticsServiceApi(api_client)
    # Initialize the data parameter object for the call
    data =  # NlpQueryExportData | 

    try:
        # Runs an Natural Language query against the specified data source and extracts the query result data into the specified format (CSV, JSON, XML).
        api_response = api_instance.extract_nlp_query_result(data)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AnalyticsServiceApi->extractNlpQueryResult: %s\n" % e)
<?php
require_once(__DIR__ . '/vendor/autoload.php');

OpenAPITools\Client\Configuration::getDefaultConfiguration()->setHost('http://Your.Server.URL');

// Configure API key authorization: paToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('paToken', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('paToken', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AnalyticsServiceApi();
$data = ; // NlpQueryExportData | 

try {
    $result = $api_instance->extractNlpQueryResult($data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsServiceApi->extractNlpQueryResult: ', $e->getMessage(), PHP_EOL;
}
?>